Get brand - Fire spark

{
  "data": {
    "id": "0001",
    "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "merchant_id": "c1d2e3f4-a5b6-7890-cdef-123456789abc",
    "name": "Burger Co.",
    "status": "ACTIVE",
    "cms_template_id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
    "cms": {
      "id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
      "name": "Brand landing page",
      "entity": "BRANDS",
      "status": "ACTIVE",
      "fields": [
        {
          "name": "tagline",
          "type": "TEXT",
          "label": { "en_us": "Tagline" },
          "required": false,
          "value": "Flame-grilled since 1987"
        }
      ]
    }
  }
}

Returns a single brand for the authenticated merchant. Use this endpoint when you already know the external id and need the current configuration without listing all brands.

Requires an access token with the brands:read scope. See Token to obtain a token.

Path parameters

Parameter	Required	Description
`id`	Yes	External brand identifier. Alphanumeric characters, `_`, and `-` only. 1–64 characters.

Request

curl "https://firespark.cloud/api/integrations/v1/brands/0001" \
  -H "Authorization: Bearer ACCESS_TOKEN"

Response

The response wraps one brand object in data. The shape matches List brands.

{
  "data": {
    "id": "0001",
    "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "merchant_id": "c1d2e3f4-a5b6-7890-cdef-123456789abc",
    "name": "Burger Co.",
    "status": "ACTIVE",
    "cms_template_id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
    "cms": {
      "id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
      "name": "Brand landing page",
      "entity": "BRANDS",
      "status": "ACTIVE",
      "fields": [
        {
          "name": "tagline",
          "type": "TEXT",
          "label": { "en_us": "Tagline" },
          "required": false,
          "value": "Flame-grilled since 1987"
        }
      ]
    }
  }
}

Error responses

Status	Description
`401`	Missing or invalid access token
`403`	Token does not include `brands:read`
`404`	No brand exists for this id